

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Dynamic REST Documentation &mdash; Dynamic REST 1.3.15 documentation</title>
  

  
  

  

  
  
    

  

  
  
    <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  

  

  
    <link rel="top" title="Dynamic REST 1.3.15 documentation" href="#"/>
        <link rel="next" title="Dynamic REST Tutorial" href="tutorial.html"/> 

  
  <script src="_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

          
            <a href="#" class="icon icon-home"> Dynamic REST
          

          
          </a>

          
            
            
              <div class="version">
                1.3.15
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
                <p class="caption"><span class="caption-text">Contents</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Dynamic REST Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="dynamic_rest.html">dynamic_rest package</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="#">Dynamic REST</a>
      </nav>


      
      <div class="wy-nav-content">
        <div class="rst-content">
          





<div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="#">Docs</a> &raquo;</li>
      
    <li>Dynamic REST Documentation</li>
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="_sources/index.txt" rel="nofollow"> View page source</a>
          
        
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="dynamic-rest-documentation">
<h1>Dynamic REST Documentation<a class="headerlink" href="#dynamic-rest-documentation" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound" id="contents">
<p class="caption"><span class="caption-text">Contents</span><a class="headerlink" href="#contents" title="Permalink to this toctree">¶</a></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Dynamic REST Tutorial</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#introduction">Introduction</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tutorial.html#setup">Setup</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#minimal-api">Minimal API</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tutorial.html#model">Model</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial.html#minimal-serializer">Minimal serializer</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial.html#minimal-viewset">Minimal ViewSet</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial.html#map-to-url">Map to URL</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial.html#try-it-out">Try it out</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial.html#serializer-with-relations">Serializer with relations</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial.html#note-on-optimizations">Note on optimizations</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#advanced-topics">Advanced Topics</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tutorial.html#serializer-field-aliasing">Serializer field aliasing</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial.html#query-parameter-injection">Query parameter injection</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial.html#queryset-override">Queryset override</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial.html#setting-serializer-context">Setting serializer context</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial.html#drest-ifying-existing-viewset">DREST-ifying Existing ViewSet</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial.html#drest-ifying-existing-serializer">DREST-ifying Existing Serializer</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial.html#customizing-serializers">Customizing Serializers</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial.html#computed-fields">Computed Fields</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial.html#ephemeral-serializers">Ephemeral Serializers</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial.html#embedded-fields">Embedded Fields</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial.html#default-filtering-of-related-objects">Default Filtering of Related Objects</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial.html#fun-times-with-default-querysets">Fun Times with Default Querysets</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial.html#dynamic-default-querysets">Dynamic Default Querysets</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial.html#dynamicmethodfield-and-prefetch-hinting">DynamicMethodField and Prefetch Hinting</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="dynamic_rest.html">dynamic_rest package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="dynamic_rest.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="dynamic_rest.html#module-dynamic_rest.bases">dynamic_rest.bases module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dynamic_rest.html#module-dynamic_rest.conf">dynamic_rest.conf module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dynamic_rest.html#module-dynamic_rest.constants">dynamic_rest.constants module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dynamic_rest.html#module-dynamic_rest.datastructures">dynamic_rest.datastructures module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dynamic_rest.html#module-dynamic_rest.fields">dynamic_rest.fields module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dynamic_rest.html#module-dynamic_rest.filters">dynamic_rest.filters module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dynamic_rest.html#module-dynamic_rest.links">dynamic_rest.links module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dynamic_rest.html#module-dynamic_rest.meta">dynamic_rest.meta module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dynamic_rest.html#module-dynamic_rest.metadata">dynamic_rest.metadata module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dynamic_rest.html#module-dynamic_rest.pagination">dynamic_rest.pagination module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dynamic_rest.html#module-dynamic_rest.patches">dynamic_rest.patches module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dynamic_rest.html#module-dynamic_rest.processors">dynamic_rest.processors module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dynamic_rest.html#module-dynamic_rest.related">dynamic_rest.related module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dynamic_rest.html#module-dynamic_rest.renderers">dynamic_rest.renderers module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dynamic_rest.html#module-dynamic_rest.routers">dynamic_rest.routers module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dynamic_rest.html#module-dynamic_rest.serializers">dynamic_rest.serializers module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dynamic_rest.html#module-dynamic_rest.tagged">dynamic_rest.tagged module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dynamic_rest.html#module-dynamic_rest.viewsets">dynamic_rest.viewsets module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dynamic_rest.html#module-dynamic_rest">Module contents</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><span>Index</span></a></li>
<li><a class="reference internal" href="py-modindex.html"><span>Module Index</span></a></li>
<li><a class="reference internal" href="search.html"><span>Search Page</span></a></li>
</ul>
</div>


           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="tutorial.html" class="btn btn-neutral float-right" title="Dynamic REST Tutorial" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2016, ant@altschool.com, ryo@altschool.com.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'./',
            VERSION:'1.3.15',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true
        };
    </script>
      <script type="text/javascript" src="_static/jquery.js"></script>
      <script type="text/javascript" src="_static/underscore.js"></script>
      <script type="text/javascript" src="_static/doctools.js"></script>

  

  
  
    <script type="text/javascript" src="_static/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>